Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
IcmpSignature Class Reference

IcmpSignature handles and manipulates ICMP signatures. More...

Public Member Functions

int getSigId ()
 Returns the signature ID. More...
 
int getSubId ()
 Returns the signature sub-id. More...
 
Bool getRetired ()
 Returns the retired value for the ICMP signature. More...
 
Bool getEnabled ()
 Returns the enabled value. More...
 
int getEventActionCount ()
 Returns the event action count. More...
 
SigEventAction getEventActionAt (int)
 Returns the event action at the specified index. More...
 
void setRetired (Bool)
 Sets the retired value. More...
 
void setEnabled (Bool)
 Sets the enabled value. More...
 
void setEventAction (SigEventAction)
 Sets the event action for the ICMP signature. More...
 

Detailed Description

IcmpSignature handles and manipulates ICMP signatures.

Member Function Documentation

◆ getEnabled()

Bool IcmpSignature::getEnabled ( )

Returns the enabled value.

Returns
enum<Bool>, the enabled value. Enabled values: eDefault = 0, eFalse = 1, eTrue = 2

◆ getEventActionAt()

SigEventAction IcmpSignature::getEventActionAt ( int  )

Returns the event action at the specified index.

Parameters
index,theindex of the event action of interest.
Returns
enum<SigEventAction>, the event action at the specified index. Event actions: eInvalid = -1, eProduceAlert = 0, eDenyPacketInline = 1, eDenyAttackerInline = 2, eDenyConnInline = 3, eRstTCPConn = 4,

◆ getEventActionCount()

int IcmpSignature::getEventActionCount ( )

Returns the event action count.

Returns
int, the event action count.

◆ getRetired()

Bool IcmpSignature::getRetired ( )

Returns the retired value for the ICMP signature.

Returns
enum<Bool>, the retired value. Retired values: eDefault = 0, eFalse = 1, eTrue = 2

◆ getSigId()

int IcmpSignature::getSigId ( )

Returns the signature ID.

Returns
int, the signature ID.

◆ getSubId()

int IcmpSignature::getSubId ( )

Returns the signature sub-id.

Returns
int, the signature sub-id.

◆ setEnabled()

void IcmpSignature::setEnabled ( Bool  )

Sets the enabled value.

Parameters
enum<Bool>,theenable value. Enabled values: eDefault = 0, eFalse = 1, eTrue = 2

◆ setEventAction()

void IcmpSignature::setEventAction ( SigEventAction  )

Sets the event action for the ICMP signature.

Parameters
eAction,theevent action at the specified index. Event actions: eInvalid = -1, eProduceAlert = 0, eDenyPacketInline = 1, eDenyAttackerInline = 2, eDenyConnInline = 3, eRstTCPConn = 4,

◆ setRetired()

void IcmpSignature::setRetired ( Bool  )

Sets the retired value.

Parameters
enum<Bool>,theretired value. Retired values: eDefault = 0, eFalse = 1, eTrue = 2

The documentation for this class was generated from the following file: